<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      <link rel="shortcut icon" href="../../img/favicon.ico" />
    <title>开发文档 - GCTG SoftWare</title>
    <link rel="stylesheet" href="../../css/theme.css" />
    <link rel="stylesheet" href="../../css/theme_extra.css" />
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
        <link href="../../css/extra.css" rel="stylesheet" />
    
      <script>
        // Current page data
        var mkdocs_page_name = "\u5f00\u53d1\u6587\u6863";
        var mkdocs_page_input_path = "user-guide\\writing-your-docs.md";
        var mkdocs_page_url = null;
      </script>
    
    <script src="../../js/jquery-3.6.0.min.js" defer></script>
    <!--[if lt IE 9]>
      <script src="../../js/html5shiv.min.js"></script>
    <![endif]-->
      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
      <script>hljs.initHighlightingOnLoad();</script> 
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
    <div class="wy-side-scroll">
      <div class="wy-side-nav-search">
          <a href="../.." class="icon icon-home"> GCTG SoftWare
        </a><div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
      <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="../..">主页</a>
                </li>
              </ul>
              <p class="caption"><span class="caption-text">用户指南</span></p>
              <ul class="current">
                  <li class="toctree-l1 current"><a class="reference internal current" href="./">开发文档</a>
    <ul class="current">
    <li class="toctree-l2"><a class="reference internal" href="#_2">文件布局</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#_3">索引页面</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#_4">配置页面和导航</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#markdown">使用Markdown写作</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#_5">内部链接</a>
        <ul>
    <li class="toctree-l4"><a class="reference internal" href="#_6">链接到页面</a>
    </li>
    <li class="toctree-l4"><a class="reference internal" href="#_7">链接到图像和媒体</a>
    </li>
    <li class="toctree-l4"><a class="reference internal" href="#html">从原始HTML链接</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#meta-data">Meta-Data</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#_8">元数据</a>
        <ul>
    <li class="toctree-l4"><a class="reference internal" href="#yaml">YAML样式元数据</a>
    </li>
    <li class="toctree-l4"><a class="reference internal" href="#multimarkdown">MultiMarkdown样式元数据</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#_9">表格</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#_10">受控代码块</a>
    </li>
        </ul>
    </li>
    </ul>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../styling-your-docs/">设置文档样式</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../configuration/">配置文件</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../deploying-your-docs/">部署文档</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../plugins/">插件</a>
                  </li>
              </ul>
              <p class="caption"><span class="caption-text">关于</span></p>
              <ul>
                  <li class="toctree-l1"><a class="reference internal" href="../../about/release-notes/">发行说明</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../../about/license/">许可</a>
                  </li>
              </ul>
      </div>
    </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
      <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../..">GCTG SoftWare</a>
        
      </nav>
      <div class="wy-nav-content">
        <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../.." class="icon icon-home" alt="Docs"></a> &raquo;</li>
          <li>用户指南 &raquo;</li>
      <li>开发文档</li>
    <li class="wy-breadcrumbs-aside">
    </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div class="section" itemprop="articleBody">
              
                <h1 id="_1">编写你的文档</h1>
<p>如何布局和编写Markdown源文件。</p>
<hr />
<h2 id="_2">文件布局</h2>
<p>文档的源文件应当是一个标准的Markdown的文件（请参阅下面的<a href="#markdown">使用Markdown编写</a>，并放置于<a href="../configuration/#docs_dir">文档目录</a>中。默认情况下，此目录将被命名为<code>docs</code>，并且将与<code>mkdocs.yml</code>配置文件一起存在于项目的顶层。</p>
<p>您可以创建的最简单的项目如下所示：</p>
<pre><code class="language-no-highlight">mkdocs.yml
docs/
    index.md
</code></pre>
<p>按照惯例，您的项目主页应命名为<code>index</code>。以下任何扩展名都可用于您的Markdown源文件：<code>markdown</code>，<code>mdown</code>，<code>mkdn</code>，<code>mkd</code>，<code>md</code>。无论设置如何，文档目录中包含的所有Markdown文件都将在构建的站点中呈现。</p>
<p>您还可以通过创建多个Markdown文件来创建多页文档：</p>
<pre><code class="language-no-highlight">mkdocs.yml
docs/
    index.md
    about.md
    license.md
</code></pre>
<p>文件的布局决定了最终生成的页面的网址。上述布局，将生成如下的结构的网址：</p>
<pre><code class="language-no-highlight">/
/about/
/license/
</code></pre>
<p>你也可以将Markdown文件置于嵌套目录中，以满足不同的布局需求。</p>
<pre><code class="language-no-highlight">docs/
    index.md
    user-guide/getting-started.md
    user-guide/configuration-options.md
    license.md
</code></pre>
<p>Source files inside nested directories will cause pages to be generated with nested URLs, like so:
如果使用了嵌套目录，那么生成页面的网址也将包含嵌套的网址：</p>
<pre><code class="language-no-highlight">/
/user-guide/getting-started/
/user-guide/configuration-options/
/license/
</code></pre>
<h3 id="_3">索引页面</h3>
<p>当请求目录时，默认情况下，大多数Web服务器将返回该目录中包含的索引文件（通常名为<code>index.html</code>）（如果存在）。 因此，上面所有示例中的主页都被命名为<code>index.md</code>，MkDocs在构建站点时将生成为<code>index.html</code>。</p>
<p>许多存储库托管站点通过在浏览目录内容时显示README文件的内容来为README文件提供特殊处理。 因此，MkDocs允许您将索引页面命名为<code>README.md</code>而不是<code>index.md</code>。这样，当用户浏览您的源代码时，存储库托管站点可以使用README文件来显示为该目录的索引页。但是，当MkDocs渲染您的站点时，该文件将重命名为<code>index.html</code>，以便服务器将其视为正确的索引文件处理。</p>
<p>如果在同一目录中同时存在<code>index.md</code>文件和<code>README.md</code>文件，则使用<code>index.md</code>文件并忽略<code>README.md</code>文件。</p>
<h3 id="_4">配置页面和导航</h3>
<p><code>mkdocs.yml</code>文件中的<a href="../configuration/#nav">nav</a>（configuration.md＃nav）配置设置定义了全局站点导航菜单中包含的页面以及该菜单的结构。如果未提供，将通过搜索[文档目录]（configuration.md＃docs_dir）中的所有Markdown文件并自动创建导航。自动创建的导航配置将始终根据文件名的字母数字顺序排序（索引文件将始终显示在最前面）。如果您希望导航菜单的排序方式不同，则需要手动定义导航配置。</p>
<p>简单的导航配置如下所示：</p>
<pre><code class="language-no-highlight">nav:
- 'index.md'
- 'about.md'
</code></pre>
<p>导航配置中的所有路径必须相对于<code>docs_dir</code>配置选项。 如果该选项设置为默认值<code>docs</code>，则上述配置的源文件将位于<code>docs/index.md</code>和<code>docs/about.md</code>。</p>
<p>上面的示例将导致在顶层创建两个导航项，并根据文件内容（如果文件中未指定标题，则是文件名）推断其标题。要为页面自定义标题，可以在文件名之前添加标题。</p>
<pre><code class="language-no-highlight">nav:
- Home: 'index.md'
- About: 'about.md'
</code></pre>
<p>请注意，如果为导航中的页面定义了标题，则该标题将在整个站点中用于该页面，并将覆盖页面本身定义的任何标题。</p>
<p>可以通过如下方式来创建二级导航：</p>
<pre><code class="language-no-highlight">nav:
- Home: 'index.md'
- User Guide:
    - 'Writing your docs': 'writing-your-docs.md'
    - 'Styling your docs': 'styling-your-docs.md'
- About:
    - 'License': 'license.md'
    - 'Release Notes': 'release-notes.md'
</code></pre>
<p>通过上述配置，我们有三个顶级项目：“Home”，“User Guide”和“About”。 “Home”是指向该网站主页的链接。在“User Guide”部分下面列出了两个页面：“Writing your docs”和“Styling your docs”。在“About”部分下面列出了另外两个页面：“License”和“Release Notes”。</p>
<p>请注意，二级导航本身不能包含页面。二级导航只能包含子页面，或者子一级的导航。你可以根据需要，逐级嵌套。但是，请注意不要使用太多的嵌套，以免影响用户的使用。虽然二级导航模仿了你的文件布局结果，但是不是必须的</p>
<p>导航配置中未列出的任何页面仍将呈现并包含在构建的站点中，但是，它们不会出现在全局导航中，也不会包含在“previous”和“next”链接中。 除非直接链接，否则此类页面将被“隐藏”。</p>
<h2 id="markdown">使用Markdown写作</h2>
<p>MkDocs的页面需使用<a href="https://daringfireball.net/projects/markdown/">Markdown</a>来创作，这是一种轻量级标记语言，可生成易于阅读，易于编写的纯文本文档，可以以可预测的方式转换为有效的HTML文档。</p>
<p>MkDocs使用<a href="https://python-markdown.github.io/">Python-Markdown</a>库将Markdown文档转换为HTML。Python-Markdown几乎完全符合<a href="https://daringfireball.net/projects/markdown/">eference implementation</a>，尽管有一些非常小的<a href="https://python-markdown.github.io/#differences">差异</a>。</p>
<p>In addition to the base Markdown <a href="https://daringfireball.net/projects/markdown/syntax">syntax</a> which is common across all Markdown implementations, MkDocs includes support for extending the Markdown syntax with Python-Markdown <a href="https://python-markdown.github.io/extensions/">extensions</a>. See the MkDocs' <a href="../configuration/#markdown_extensions">markdown_extensions</a> configuration setting for details on how to enable extensions.
除了适配基本的Markdown<a href="https://daringfireball.net/projects/markdown/syntax">语法</a>之外，MkDocs还支持使用Python-Markdown<a href="https://python-markdown.github.io/extensions/">extensions</a>扩展Markdown语法。有关如何启用扩展的详细信息，请参阅MkDocs的<a href="../configuration/#markdown_extensions">markdown_extensions</a>配置设置。</p>
<p>MkDocs默认包含一些扩展，在下面突出显示。</p>
<h3 id="_5">内部链接</h3>
<p>MkDocs允许您通过使用常规Markdown<a href="https://daringfireball.net/projects/markdown/syntax#link">链接</a>来链接您的文档。但是，如下所述，格式化专门针对MkDocs的链接还有一些额外的好处。</p>
<h4 id="_6">链接到页面</h4>
<p>在文档中的页面之间进行链接时，您只需使用常规的Markdown<a href="https://daringfireball.net/projects/markdown/syntax#link">链接</a>语法，包括<em>相对路径</em>到您希望链接到的Markdown文档。</p>
<pre><code class="language-no-highlight">Please see the [project license](license.md) for further details.
</code></pre>
<p>当MkDocs构建运行时，这些Markdown链接将自动转换为指向相应HTML页面的HTML超链接。</p>
<p>!!! warning
    使用带链接的绝对路径不受官方支持。 相对路径由MkDocs调整，以确保它们始终相对于页面。绝对路径根本不会被修改。这意味着使用绝对路径的链接可能在本地环境中正常工作，但是一旦将它们部署到生产服务器，它们可能会不能正常实现。</p>
<p>如果目标文档文件位于另一个目录中，则需要确保在链接中包含任何相对目录路径。</p>
<pre><code class="language-no-highlight">Please see the [project license](../about/license.md) for further details.
</code></pre>
<p>MkDocs使用<a href="https://python-markdown.github.io/extensions/toc/">toc</a>扩展名为Markdown文档中的每个header生成一个ID。 您可以使用该ID链接到目标文档中的相应部分。 生成的HTML将正确转换链接的路径，并使锚点来完成跳转。</p>
<pre><code class="language-no-highlight">Please see the [project license](about.md#license) for further details.
</code></pre>
<p>请注意，ID是从header的文本来创建的。 所有文本都转换为小写，任何不允许的字符（包括空格）都将转换为下划线。 连续的下划线将转换为一个下划线。</p>
<p>toc扩展提供了一些配置设置，您可以在<code>mkdocs.yml</code>配置文件中设置这些设置以更改默认行为：</p>
<p><code>permalink</code>:</p>
<p>: 在每个标头的末尾生成永久链接。 默认值：<code>False</code>。</p>
<pre><code>设置为True时，段落符号（＆para;或`＆para;`）用作链接文本。 设置为字符串时，提供的字符串将用作链接文本。 例如，要使用哈希符号（`＃`），请执行以下操作：

    markdown_extensions:
        - toc:
            permalink: "#"
</code></pre>
<p><code>baselevel</code>:</p>
<p>: 标头的基本级别。 默认值：<code>1</code>。</p>
<pre><code>此设置允许自动调整标题级别以适合HTML模板的层次结构。例如，如果页面的Markdown文本不应包含高于级别2（`&lt;h2&gt;`）的任何标题，请执行以下操作：

    markdown_extensions:
        - toc:
            baselevel: 2

然后，文档中的任何标题都将增加1.例如，标题`#Header`将在HTML输出中呈现为2级标题（`&lt;h2&gt;`）。
</code></pre>
<p><code>separator</code>:</p>
<p>: 单词分隔符。 默认值：<code>-</code>。</p>
<pre><code>替换生成的ID中的空格的字符。 如果你喜欢下划线，那么：

    markdown_extensions:
        - toc:
            separator: "_"
</code></pre>
<p>请注意，如果要定义上述设置中的多个，则必须在<code>markdown_extensions</code>配置选项中的单个<code>toc</code>条目下执行此操作。</p>
<pre><code class="language-yml">markdown_extensions:
    - toc:
        permalink: &quot;#&quot;
        baselevel: 2
        separator: &quot;_&quot;
</code></pre>
<h4 id="_7">链接到图像和媒体</h4>
<p>除Markdown源文件外，您还可以在文档中包含其他文件类型，这些文件类型将在生成文档站点时复制。这些可能包括图像和其他媒体。</p>
<p>例如，如果您的项目文档需要包含<a href="https://help.github.com/articles/using-a-custom-domain-with-github-pages/">GitHub页面CNAME文件</a>和PNG格式的屏幕截图图像，那么您的文件布局可能如下所示：</p>
<pre><code class="language-no-highlight">mkdocs.yml
docs/
    CNAME
    index.md
    about.md
    license.md
    img/
        screenshot.png
</code></pre>
<p>要在文档源文件中包含图像，只需使用任何常规的Markdown图像语法：</p>
<pre><code class="language-Markdown">Cupcake indexer is a snazzy new project for indexing small cakes.

![Screenshot](img/screenshot.png)

*Above: Cupcake indexer in progress*
</code></pre>
<p>现在，您可以在构建文档时嵌入图像，如果您使用的是Markdown编辑器来处理文档，也应该可以预览该图像。</p>
<h4 id="html">从原始HTML链接</h4>
<p>当Markdown语法不符合作者的需要时，Markdown允许文档作者回退到原始HTML。MkDocs在这方面并不限制Markdown。 但是，由于Markdown解析器忽略了所有原始HTML，因此MkDocs无法验证或转换原始HTML中包含的链接。在原始HTML中包含内部链接时，您需要为呈现的文档手动格式化链接。</p>
<h3 id="meta-data">Meta-Data</h3>
<h3 id="_8">元数据</h3>
<p>MkDocs包括支持YAML和MultiMarkdown两种样式的元数据（通常称为前端内容）。元数据由Markdown文档开头定义的一系列关键字和值组成，这些关键字和值在Python-Markdown处理之前从文档中删除。键/值对由MkDocs传递给页面模板。 因此，如果主题支持，则任何键的值都可以显示在页面上或用于控制页面呈现。有关可能支持哪些关键字的详细信息，请参阅相应的主题支持文档（如果有）。</p>
<p>除了在模板中显示信息之外，MkDocs还支持一些预定义的元数据键，这些键可以改变该特定页面的MkDoc的行为。支持以下键：</p>
<p><code>template</code>:</p>
<p>: The template to use with the current page.
: 用于当前页面的模板。</p>
<pre><code>默认情况下，MkDocs使用主题的`main.html`模板来呈现Markdown页面。您可以使用`template`元数据键为该特定页面定义不同的模板文件。模板文件必须在主题环境中定义的路径上可用。
</code></pre>
<p><code>title</code>:</p>
<p>: 用于文档的“标题”。</p>
<pre><code>MkDocs将尝试按以下方式确定文档的标题：

1.在文档的[nav]配置设置中定义的标题。

2.在文档的“title”元数据键中定义的标题。

3.文档正文第一行上的1级Markdown标题。

4.文档的文件名。

在找到页面的标题后，MkDoc不会继续检查上面列表中的任何其他来源。
</code></pre>
<h4 id="yaml">YAML样式元数据</h4>
<p>YAML样式元数据由YAML样式分隔符中包含的<a href="http://yaml.org">YAML</a>键/值对组成，以标记元数据的开始和/或结束。 文档的第一行必须是<code>---</code>。 元数据在结束的那一行，需包含一个结束分隔符（<code>---</code>或<code>...</code>）。 分隔符之间的内容被解析为<a href="http://yaml.org">YAML</a>。</p>
<pre><code class="language-no-highlight">---
title: My Document
summary: A brief description of my document.
authors:
    - Waylan Limberg
    - Tom Christie
date: 2018-07-10
some_url: https://example.com
---
This is the first paragraph of the document.
</code></pre>
<p>YAML能够检测数据类型。因此，在上面的例子中，<code>title</code>，<code>summary</code>和<code>some_url</code>的值是字符串，<code>authors</code>的值是字符串列表，<code>date</code>的值是<code>datetime.date</code>对象。请注意，YAML键区分大小写，MkDocs期望键全部为小写。YAML的顶级必须是键/值对的集合，这导致返回Python<code>dict</code>。如果返回任何其他类型或YAML解析器遇到错误，则MkDocs不会将该部分识别为元数据，页面的<code>meta</code>属性将为空，并且该部分不会从文档中删除。</p>
<h4 id="multimarkdown">MultiMarkdown样式元数据</h4>
<p>MultiMarkdown样式元数据使用<a href="http://fletcherpenney.net/MultiMarkdown_Syntax_Guide#metadata">MultiMarkdown</a>项目首先引入的格式。该数据由Markdown文档开头定义的一系列关键字和值组成，如下所示：</p>
<pre><code class="language-no-highlight">Title:   My Document
Summary: A brief description of my document.
Authors: Waylan Limberg
         Tom Christie
Date:    January 23, 2018
blank-value:
some_url: https://example.com

This is the first paragraph of the document.
</code></pre>
<p>关键字不区分大小写，可以包含字母，数字，下划线和短划线，并且必须以冒号结尾。值由冒号后面的任何内容组成，甚至可以为空。</p>
<p>如果一行由4个或更多空格缩进，则该行被假定为前一个关键字的值的附加行。关键字可以包含所需的行数。所有行都连接成一个字符串。</p>
<p>第一个空白行结束文档的所有元数据。 因此，文档的第一行不能为空。</p>
<p>!!! note</p>
<pre><code>对于MultiMarkdown样式的元数据，MkDocs不支持YAML样式的分隔符（`---`或` ``` `）。实际上，MkDocs依赖于分隔符的存在与否来确定是否正在使用YAML样式的元数据或MultiMarkdown样式的元数据。 如果检测到分隔符，但是分隔符之间的内容不是有效的YAML元数据，则MkDocs不会尝试将内容解析为MultiMarkdown样式的元数据。
</code></pre>
<h3 id="_9">表格</h3>
<p><a href="https://python-markdown.github.io/extensions/tables/">表格</a>扩展为Markdown添加了一个基本的表格语法，它在多个实现中很流行。 语法相当简单，通常仅对简单的表格数据有用。</p>
<p>一个简单的表看起来像这样：</p>
<pre><code class="language-no-highlight">First Header | Second Header | Third Header
------------ | ------------- | ------------
Content Cell | Content Cell  | Content Cell
Content Cell | Content Cell  | Content Cell
</code></pre>
<p>如果您愿意，可以在表格的每一行添加一个前导和尾随管道：</p>
<pre><code class="language-no-highlight">| First Header | Second Header | Third Header |
| ------------ | ------------- | ------------ |
| Content Cell | Content Cell  | Content Cell |
| Content Cell | Content Cell  | Content Cell |
</code></pre>
<p>通过向分隔线添加冒号来指定每列的对齐方式：</p>
<pre><code class="language-no-highlight">First Header | Second Header | Third Header
:----------- |:-------------:| -----------:
Left         | Center        | Right
Left         | Center        | Right
</code></pre>
<p>请注意，表格单元格不能包含任何块级别元素，并且不能包含多行文本。 但是，它们可以包含Markdown<a href="https://daringfireball.net/projects/markdown/syntax">语法</a>规则中定义的内联Markdown。</p>
<p>此外，表必须用空行包围。 表格前后必须有一个空行。</p>
<h3 id="_10">受控代码块</h3>
<p><a href="https://python-markdown.github.io/extensions/fenced_code_blocks/">fenced code blocks</a>扩展添加了一种定义代码块的替代方法，无需缩进。</p>
<p>第一行应包含3个或更多反引号（<code>`</code>）字符，最后一行应包含相同数量的反引号字符（<code>`</code>）：</p>
<pre><code class="language-no-highlight">```
Fenced code blocks are like Standard Markdown’s regular code blocks, except that they’re not indented and instead rely on start and end fence lines to delimit the code block.
```
</code></pre>
<p>使用这种方法，可以选择在反引号后的第一行指定语言，该反引号通知所使用语言的任何语法高亮显示器：</p>
<pre><code class="language-no-highlight">```python
def fn():
    pass
```
</code></pre>
<p>请注意，受限制的代码块不能缩进。 因此，它们不能嵌套在列表项，块引用等内。</p>
              
            </div>
          </div><footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
        <a href="../.." class="btn btn-neutral float-left" title="主页"><span class="icon icon-circle-arrow-left"></span> Previous</a>
        <a href="../styling-your-docs/" class="btn btn-neutral float-right" title="设置文档样式">Next <span class="icon icon-circle-arrow-right"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
  </div>

  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
          
        </div>
      </div>

    </section>

  </div>

  <div class="rst-versions" role="note" aria-label="Versions">
  <span class="rst-current-version" data-toggle="rst-current-version">
    
    
      <span><a href="../.." style="color: #fcfcfc">&laquo; Previous</a></span>
    
    
      <span><a href="../styling-your-docs/" style="color: #fcfcfc">Next &raquo;</a></span>
    
  </span>
</div>
    <script>var base_url = '../..';</script>
    <script src="../../js/theme_extra.js" defer></script>
    <script src="../../js/theme.js" defer></script>
      <script src="../../search/main.js" defer></script>
    <script defer>
        window.onload = function () {
            SphinxRtdTheme.Navigation.enable(true);
        };
    </script>

</body>
</html>
